home *** CD-ROM | disk | FTP | other *** search
/ The Epic Collection 3 / Epic Collection 3, The (1997)(Epic Marketing)[!].iso / applications / textengine / textengine.doc < prev    next >
Text File  |  1992-09-02  |  20KB  |  460 lines

  1.  
  2.          TextEngine V4.1, Copyright Nicholas Harvey, 1991-93
  3.  
  4. INTRODUCTION
  5. ============
  6. Welcome to TextEngine, a shareware word processing system for the CBM 
  7. Amiga. Some of the features of this latest version are as follows...
  8.  
  9.  - Brand new screen layout.
  10.  - Text searcher facility.
  11.  - 128Kb text buffer.
  12.  - Built-in spell checker with 36,000 word dictionary.
  13.  - Fully WB2 (and above) compatible with enhanced features on these 
  14.    versions of the OS (e.g. proper file requesters, & super hires 
  15.    display ability).
  16.  - ASCII files can be loaded and saved with ease.
  17.  - 12 text styles available for use with any preferences supported 
  18.    printer.
  19.  - Up to 99 copies of a document can be printed at once.
  20.  - Complete configuration options covering page margins, macros 
  21.    (function keys), and colour palette.
  22.  - Both PAL and NTSC monitors are supported, with the choice of hires,
  23.    super hires (WB2 or above only), and interlaced screen 
  24.    displays.
  25.  - Full word wrap.
  26.  - Various statistical information available such as the number of 
  27.    words, lines and pages a document contains.
  28.  
  29. TextEngine is shareware, and I give my permission for it to be freely 
  30. distributed. If you use it regularly, or are just feeling generous, 
  31. then please help out this poor student and register with me by sending
  32. £5 (or equivalent) to the address below:
  33.  
  34.         Nicholas Harvey
  35.         149 Manor Road North
  36.         Thames Ditton
  37.         Surrey
  38.         KT7 0BQ
  39.         England
  40.  
  41. I am particularly interested in hearing from anyone who uses 
  42. TextEngine outside the UK. So, if you live across the Channel, or 
  43. even the Atlantic, then I would be most interested to hear what you
  44. have to say about the program!
  45.  
  46.  
  47. SYSTEM REQUIREMENTS
  48. ===================
  49. TextEngine should run on any memory configuration from 1/2 MB chip RAM
  50. upwards, although at least 1MB is required if you want to use the 
  51. spell checker. The following files are required to be present on your
  52. disk for the program to work (please note that the .gfx file is 
  53. now no longer needed).
  54.  
  55.   TextEngine4.1.cfg - This contains the user's prefered setup for 
  56.                       TextEngine which is loaded on startup and used 
  57.                       to configure the program to the user's needs. 
  58.                       This should be in the same directory as 
  59.                       TextEngine.
  60.  
  61.   TextEngine4.1.dct - This is the dictionary used by TextEngine's 
  62.                       spell checker, and this must also be in 
  63.                       TextEngine's directory.
  64.  
  65.    libs/asl.library - Only WB 2.04 users will need this if they want 
  66.                       to use file requesters with TextEngine.
  67.  
  68. devs/printer.device - This file is needed for printing, along with 
  69.                       your printer driver, which should be in the 
  70.                       devs/printers directory.
  71.  
  72.      l/port-handler - Also needed for printing.
  73.  
  74.  
  75. HARD DISK INSTALLATION
  76. ======================
  77. Installing TextEngine V4.1 on a hard disk is very easy. Simply create 
  78. a directory anywhere on your hard disk, and then copy the following 
  79. files into it:
  80.  
  81.         TextEngine
  82.         TextEngine.info
  83.         TextEngine4.1.cfg
  84.         TextEngine4.1.dct
  85.  
  86. Alternatively, using workbench you can simply drag the TextEngine 
  87. drawer from your floppy disk into any directory on your hard disk.
  88.  
  89.  
  90. LOADING TEXTENGINE
  91. ==================
  92. From workbench: Simply double-click on the TextEngine icon and the 
  93.                 program will load.
  94.  
  95. From the CLI:   Lets assume TextEngine is stored in a directory called
  96.                 WORDPROCESSORS. Firstly, type the following:
  97.  
  98.         cd wordprocessors (and press RETURN)
  99.  
  100.                 Now, to run TextEngine, type:
  101.  
  102.         run TextEngine <filename> (and press RETURN)
  103.  
  104.                 If you enter the name of a document in the filename
  105.                 option, it will be loaded automatically on startup.
  106.  
  107.  
  108. SETTING UP TEXTENGINE
  109. =====================
  110. TextEngine can be configured to suit most people's needs by using the 
  111. following menu selections:
  112.  
  113. TEXT/WORDWAP  - Selecting this toggles the wordwrap on and off.
  114.  
  115. PREFS/PRINTER - Here, the paper margins can be altered by changing the 
  116.                 values contained in the following boxes:
  117.  
  118. Lines per page: Here you enter the maximum number of lines that can 
  119. be printed on your piece of paper with no gaps at the top or bottom.
  120. This is usually set at 70 for A4 continuous paper. If you are using 
  121. single sheets (like I do) then your printer may not allow you to use 
  122. the whole length of the page, due to the 'paper out' detector. In this
  123. case, you will need to enter a smaller number in this box. For 
  124. example, my Star LC10 allows me to print 59 lines per page on a single
  125. A4 sheet.
  126.  
  127. Top margin: Enter the number of blank lines you want placed at the top
  128. of the page in here.
  129.  
  130. Bottom margin: Enter the number of blank lines you want placed at the 
  131. bottom of the page in here.
  132.  
  133. If, for example, you specified 70 lines per page with a 5 line margin 
  134. at the top and bottom, then the maximum number of lines on that page 
  135. would be 70 - 5 - 5 = 60 lines.
  136.  
  137. Chars per line: Here you enter the maximum number of characters that 
  138. can be printed across the page from left to right with no gaps either 
  139. side. This is usually set at 80 for A4 paper.
  140.  
  141. Left margin: This defines the width of the left margin in characters.
  142.  
  143. Right margin: This defines the width of the right margin in 
  144. characters.
  145.  
  146. Clicking on the DOUBLE SPACING gadget toggles double line spacing on 
  147. and off. Please note that the double spacing effect only becomes 
  148. apparent when your document is printed.
  149.  
  150. PREFS/PALETTE     - Here you can change the colours of the editor 
  151.                     screen.
  152.  PREFS/MACROS     - Here you can assign each of the ten function keys 
  153.                     a string of 100 characters which is entered into 
  154.                     your document each time they are pressed. This 
  155.                     can be very useful when you repeat a word or 
  156.                     phrase many times.
  157.    PREFS/NTSC     - Using this option will toggle between PAL and 
  158.                     NTSC screen modes.
  159. PREFS/INTERLACE   - This will toggle the screen between interlaced
  160.                     and non-interlaced displays.
  161. PREFS/SUPER HIRES - If you have WB2 or above, a decent monitor, and 
  162.                     eye-sight to match, then selecting this will put 
  163.                     TextEngine into super hires mode!
  164.  
  165. To save this setup to disk, select PREFS/SAVE PREFERENCES. This writes
  166. all of the above information to the TextEngine4.1.cfg file (N.B. the
  167. ability to save the macros in this file is a new feature of V4.1). 
  168.  
  169. However, every time you save your edited document, (except as ASCII 
  170. text) the macro and margin information is saved with it, so that every
  171. file has its own individual set of macros and margins. This, however,
  172. does not affect the setup saved in the .cfg file.
  173.  
  174.  
  175. DISK FUNCTIONS
  176. ==============
  177. TextEngine V4.1 uses its own file format which is different to that of
  178. ASCII files, and of older versions of TextEngine (V4.0 and lower). 
  179. However old TextEngine files and ASCII files can be loaded without
  180. conversion, and are detected automatically when loaded using the
  181. FILE/LOAD menu option.
  182.  
  183. N.B. Files saved from TextEngine V4.1 (excluding ASCII files) cannot 
  184. be loaded correctly into earlier versions of the program.
  185.  
  186. In the FILE menu, there are the following options:
  187.  
  188.       LOAD - Lets you load a file. Both ASCII and TextEngine format
  189.              files can be loaded.
  190.     APPEND - Lets you merge a file with the current document. The 
  191.              file is loaded into your document at the cursor position.
  192.              Only TextEngine format files can be appended.
  193.       SAVE - This writes your file back onto the disk under the same 
  194.              filename as it was loaded. No file requesters are 
  195.              displayed so this is a quick way of re-saving a file 
  196.              after it has been loaded and amended.
  197.    SAVE AS - Lets you save your file in TextEngine format via a file  
  198.              requester.
  199. SAVE ASCII - This saves your file in ASCII format via a file 
  200.              requester.
  201.      ERASE - Lets you erase a file.
  202.        DIR - This feature is only available if you are using WB 
  203.              1.2/1.3, or if TextEngine fails to open the asl.library. 
  204.              It displays the contents of a given directory, and is 
  205.              useful for locating files on the disk.
  206.  
  207. When using TextEngine with WB 2 or above, proper file requesters are 
  208. used to select a file name for the above functions. Unfortunately,
  209. these are not available when using WB 1.2/1.3, but instead the user
  210. must simply type the file name in at the LOAD/SAVE/APPEND/ERASE
  211. prompts.
  212.  
  213. If TextEngine fails to carry out a file function for any reason, then 
  214. an error message is displayed. These errors are explained fully in the
  215. section 'AMIGADOS ERROR MESSAGES'.
  216.  
  217.  
  218. EDITING A DOCUMENT
  219. ==================
  220. There is a text buffer of 131200 bytes available, which should be 
  221. large enough for most purposes. If you want to write larger documents,
  222. then it might be a good idea to separate them into smaller sections 
  223. and edit these individually. When the text buffer is full, an error
  224. message is displayed. To see how much room there is left in the
  225. buffer, select ABOUT from the PROJECT menu.
  226.  
  227.  
  228. Keyboard input:
  229. Text is entered in the normal way with the keyboard, with the 
  230. following extra keyboard functions being available:
  231.  
  232.  SHIFT+LEFT CURSOR - Start of line.
  233. SHIFT+RIGHT CURSOR - End of line.
  234.    SHIFT+UP CURSOR - Page up.
  235.  SHIFT+DOWN CURSOR - Page down.
  236.             CTRL+T - Top of file (also available in the TEXT menu).
  237.             CTRL+B - Bottom of file (also available in the TEXT 
  238.                      menu).
  239.             CTRL+C - Centre line (also available in the TEXT menu).
  240.             F1-F10 - The ten function keys will each insert a user 
  241.                      defined string of text (as defined in the MACRO 
  242.                      editor) into the file.
  243.  
  244. The cursor can now also be positioned using the mouse. Simply click
  245. anywhere on the screen with the left mouse button to reposition the 
  246. cursor.
  247.  
  248. On-screen displays:
  249. Along the top of the screen is a ruler with each of the small
  250. divisions representing one character, and the larger ones 
  251. representing each of the 9 tab positions. The blue 'Y' shaped marker 
  252. represents the maximum width of the page. The position of this marker 
  253. is calculated from the values entered in the PRINTER PREFERENCES
  254. window and represents the horizontal limit of your paper.
  255.  
  256. Along the bottom of the screen is a status bar which displays the
  257. following information:
  258.  
  259.      LINE - The current line at which the cursor is situated.
  260. PAGE/LINE - The current page, and line on that page, which the cursor 
  261.             is located on.
  262.        WW - Word wrap status (ON or OFF).
  263.      CHIP - The amount of system chip ram currently available.
  264.      FAST - The amount of system fast ram currently available.
  265.  
  266. The PAGE/LINE numbers are calculated using the values entered in the 
  267. PRINTER PREFERENCES window (including the double spacing status), so 
  268. that they represent the limits of the paper you are using.
  269.  
  270.  
  271. Word wrap:
  272. When the current line becomes longer than the width of the page (as 
  273. defined in PRINTER PREFERENCES), the word wrap comes into action. 
  274. There are two different ways in which the word wrap takes effect:
  275.  
  276. 1) If you are editing the last word on the line, then when the word 
  277. wrap takes effect a new line is created below the current one, and the
  278. last word is pushed onto it.
  279.  
  280. 2) If you are editing elsewhere on the current line, then when the 
  281. word wrap takes effect the last word of that line is pushed onto the 
  282. beginning of the line below, if there is room for it. If there is not 
  283. room for the word on the line below, a new line is created and the 
  284. word is pushed onto that.
  285.  
  286. When the word wrap is turned off (by selecting the TEXT/WORD WRAP menu
  287. option) the full width of the screen is available for editing, and 
  288. text input stops when the cursor reaches the right hand edge.
  289.  
  290.  
  291. Merging 2 lines with the backspace:
  292. Lets imagine you had the following two lines in your file:
  293.  
  294. Jack and Jill went up the hill to fetch a pail of water,
  295. Jack fell down and broke his crown, and Jill came tumbling after.
  296.  
  297. You can merge the two lines by placing the cursor at the start of the
  298. second line and pressing the backspace key. The result in this 
  299. instant, assuming that you are using a 70 character wide page, would
  300. be the following:
  301.  
  302. Jack and Jill went up the hill to fetch a pail of water, Jack fell
  303. down and broke his crown, and Jill came tumbling after.
  304.  
  305.  
  306. Cut/copy and paste:
  307. Up to 70 lines can be cut or copied into a buffer and pasted elsewhere
  308. in the document. The procedure for this is quite simple:
  309.  
  310. 1) Place the cursor at the top of the block of text and select MARK 
  311.    TOP from the BLOCK menu.
  312. 2) Move the cursor down to the bottom of the block, and either select 
  313.    CUT TEXT or COPY TEXT from the BLOCK menu. This will either cut 
  314.    the block of text from the file into the cut buffer, or just copy
  315.    the block into the buffer whilst leaving it intact in the file.
  316. 3) Move the cursor to the position you want to paste the block you 
  317.    have just copied, and select PASTE from the BLOCK menu.
  318.  
  319. Please note that only whole lines can be cut, copied, and pasted.
  320.  
  321.  
  322. Printer styles:
  323. In the STYLE menu are a number of text styles that can be used in your
  324. document. Selecting an option from this menu inserts the corresponding
  325. control character into your file which, when the file is printed,
  326. tells your printer to turn on that style. The next time the same
  327. character appears, the printer is told to turn off that style. This is
  328. true for all styles except for PICA and ELITE, which cancel each other
  329. out. Take the following line of text, for example:
  330.  
  331. There's simply no match for °TextEngine's° user friendliness!
  332.  
  333. When printed, the first five words are printed normally, then the word
  334. "TextEngine's" is printed in italics, and the rest of the sentence is 
  335. printed normally again. Please note that not all printers support all 
  336. of these styles, but try them out and see for yourself.
  337.  
  338. If you use many styles at once, and want to cancel them together, then
  339. why not use the CANCEL STYLES control character? This cancels any 
  340. styles which are currently selected and returns the printer to normal 
  341. draft mode.
  342.  
  343.  
  344. CHECKING YOUR SPELLING
  345. ======================
  346. TextEngine has an English spell checker built in which, despite its 
  347. simplicity, can be very useful if you want to double check your
  348. typing. You may, however, find it a good idea to have a dictionary to
  349. hand in order to check those words which TextEngine hasn't seen
  350. before!
  351.  
  352. Operating the spell checker is very simple. Firstly, you must open the
  353. dictionary by selecting OPEN DICTIONARY from the SPELL menu. This 
  354. reserves a block of memory and loads the file TextEngine4.1.dct into 
  355. it. Having done this, you will find that three more options have 
  356. appeared in the SPELL menu, CLOSE DICTIONARY, UPDATE DICTIONARY, and 
  357. CHECK DOCUMENT.
  358.  
  359. When you select CHECK DOCUMENT, the spell checker window is opened and
  360. it begins to check your file. When a potentially incorrect word is 
  361. found, it is displayed in the string gadget and seven suggestions are 
  362. shown in the box on the right (which can be scrolled using the up and 
  363. down arrow buttons). If the word is correct, you can either click on
  364. ADD which will add the word to the dictionary and continue on to the
  365. next word, or NEXT which will ignore the word and carry on to the next
  366. one. However, if the word is incorrect, then you can correct it using
  367. the string gadget and then click on NEXT to continue.
  368.  
  369. After using the spell checker, you may have added some words to the 
  370. dictionary which you want kept there. In this case, select UPDATE 
  371. DICTIONARY from the SPELL menu, which saves the dictionary with your 
  372. additions back to disk for future use. Also, if your system is running
  373. low on memory, you can remove the dictionary from RAM by selecting 
  374. CLOSE DICTIONARY.
  375.  
  376.  
  377. OTHER FEATURES OF TEXTENGINE V4.1
  378. =================================
  379. A new feature in the TEXT menu is FIND TEXT STRING. When this is
  380. selected, you are asked to type in the text you want to look. Having 
  381. done this, click on the FIND gadget and TextEngine will look through 
  382. your document for the next occurance of that string. Having found it, 
  383. you can continue searching by selecting the TEXT/FIND NEXT menu item.
  384.  
  385. To print a file, select PRINT from the PROJECT menu. A requester will 
  386. appear asking you how many copies of the file you want printed. Up to 
  387. 99 copies can be made, and if you enter 0 as the value, then printing
  388. will not go ahead. If you need to stop printing for some reason, 
  389. simply click on the CANCEL gadget.
  390.  
  391. Selecting SLEEP from the PROJECT menu returns you to the Workbench 
  392. and reduces TextEngine to a small window at the top of the screen. In
  393. doing this, about 50kB of chip RAM is released and TextEngine will let
  394. other tasks get on with what they are doing without taking up valuable
  395. processor time. To return to the editor screen, make sure the small
  396. TextEngine window is selected, and then press the right mouse button.
  397.  
  398. In the TEXT menu is the WORD COUNT option. Not only does this count 
  399. the words in the document, but also the lines and pages too.
  400.  
  401.  
  402. AMIGADOS ERROR MESSAGES
  403. =======================
  404. If an error occurs when accessing a file with TextEngine, an AmigaDOS
  405. error number is displayed. Here is a list of the meanings of most
  406. errors that might occur.
  407.  
  408.         Error | Meaning
  409.         ------+--------------------------------
  410.         202   | Object in use
  411.         203   | Object already exists
  412.         204   | Directory not found
  413.         205   | Object not found
  414.         212   | Object not of required type
  415.         213   | Disk not validated
  416.         214   | Disk write-protected
  417.         218   | Device not mounted
  418.         221   | Disk full
  419.         222   | File is protected from deletion
  420.         223   | File is protected from writing
  421.         224   | File is protected from reading
  422.         225   | Not a DOS disk
  423.         226   | No disk in drive
  424.  
  425.  
  426. FINAL NOTE, THANKS, AND HELLOS
  427. ==============================
  428. Well, as usual I hope you enjoy using TextEngine. Not bad for a 
  429. fiver's worth of software, I think!
  430.  
  431. Many thanks for the support I have had from the following people:
  432. John Reece, Michael Amoah, Paul Burnham, M Rhodes, C Ralfe, Ian 
  433. Rawlings, G Lambert, S May, Stan Davey, R Evans, P Sullivan, David 
  434. McClay, E Berney, John Ellis, J Jarret, Gary Shaw, R Chambers, P Berg,
  435. Peter Stubbs, Graeme McGibbon, D Simons, Len Mullenger, Alan Lingard, 
  436. Christopher Jones, Sheila Walsh, Pauli Hietala (hello Finland!), 
  437. Andrew Chambers, A Gravener, C Wellman, R Minns, Ken Spry, 17 Bit, 
  438. Deltrax, David Aslett, Bill Sloan, Keith Pang, D Davies, Victor Hunt, 
  439. J Bryer, B Wyatt, Ernest Wilson, Larry Cashill, Dennis Brunskill, Roy 
  440. Pearson, N Peters, Colin Curtis, W Davies, Tony Campbell, T Dullage, 
  441. Frank Mitchell, Jim Finney, Graham Adair, Tony Davies, R Robertson, 
  442. Marcus Ong, Ian Ridehalgh, Cyril Stacey, Adrian Nudel, Paul Hayball, 
  443. M F Sheard, John Perks, P L Hammour, P R Thomas, Gillian Beton, Denis 
  444. Pycroft, Geoff Bowell, Richard Dockett, Mr & Mrs Dickinson, J 
  445. Rimington, Jagdeep Lall, Piers Kurrein, Russell Tippett, Ian Seth, R 
  446. Blayney, George Johnston, Peter Hind, Robert Iveson, J E Standley, 
  447. Geoff Thomas, Rocky Daly, Adrian Back, William Mutch, Roger Coleman, 
  448. Dave Hawley, Colin Standley, Archie Allison, Ricky Clarke, G M 
  449. Nicholas, Turtle Lightning Amiga Software (Texas, USA!), Kate 
  450. Simmonds, Michael Taylor, M Newsham, Colin Coomber, Alex Kane, Tony 
  451. Green, Robert Lake, and Jen Allen.
  452.  
  453. Usual hellos go to: Mark Higgins, Martin Guy, Warren Saunders, 
  454. Gary Taylor, and Amanda, Lucy, Susan, and Sophie. Also hello to
  455. everyone at JS Surbiton including Scott (graphic artist extrordinaire)
  456. Lewis, and anyone who drives a Mini!
  457.  
  458. Signed: Nick (21/8/93)
  459.  
  460.